/*
 * smartctl.h
 *
 * Home page of code is: http://www.smartmontools.org
 *
 * Copyright (C) 2002-10 Bruce Allen
 * <smartmontools-support@lists.sourceforge.net>
 * Copyright (C) 2008-10 Christian Franke
 * <smartmontools-support@lists.sourceforge.net>
 * Copyright (C) 2000 Michael Cornwell <cornwell@acm.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * You should have received a copy of the GNU General Public License
 * (for example COPYING); if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This code was originally developed as a Senior Thesis by Michael Cornwell
 * at the Concurrent Systems Laboratory (now part of the Storage Systems
 * Research Center), Jack Baskin School of Engineering, University of
 * California, Santa Cruz. http://ssrc.soe.ucsc.edu/
 *
 */

#ifndef SMARTCTL_H_
#define SMARTCTL_H_

#define SMARTCTL_H_CVSID "$Id$\n"

// Return codes (bitmask)

// command line did not parse, or internal error occured in smartctl
#define FAILCMD (0x01 << 0)

// device open failed
#define FAILDEV (0x01 << 1)

// device is in low power mode and -n option requests to exit
#define FAILPOWER (0x01 << 1)

// read device identity (ATA only) failed
#define FAILID (0x01 << 1)

// smart command failed, or ATA identify device structure missing information
#define FAILSMART (0x01 << 2)

// SMART STATUS returned FAILURE
#define FAILSTATUS (0x01 << 3)

// Attributes found <= threshold with prefail=1
#define FAILATTR (0x01 << 4)

// SMART STATUS returned GOOD but age attributes failed or prefail
// attributes have failed in the past
#define FAILAGE (0x01 << 5)

// Device had Errors in the error log
#define FAILERR (0x01 << 6)

// Device had Errors in the self-test log
#define FAILLOG (0x01 << 7)

// Classes of SMART commands.  Here 'mandatory' means "Required by the
// ATA/ATAPI-5 Specification if the device implements the S.M.A.R.T.
// command set."  The 'mandatory' S.M.A.R.T.  commands are: (1)
// Enable/Disable Attribute Autosave, (2) Enable/Disable S.M.A.R.T.,
// and (3) S.M.A.R.T. Return Status.  All others are optional.
enum failure_type {
  OPTIONAL_CMD,
  MANDATORY_CMD,
};

// Globals to set failuretest() policy
extern bool failuretest_conservative;
extern unsigned char failuretest_permissive;

// Compares failure type to policy in effect, and either exits or
// simply returns to the calling routine.
void failuretest(failure_type type, int returnvalue);

/*
* @brief Compares failure type to policy.
*
* @param failure type of either OPTIONAL_CMD or MANDATORY_CMD
*
* @return true for pass, false for fail
 */
// This function only returning a primitive type for consistency with rest of
// code.  This may need to be refactored to return specific Err Types (which
// handled at the )
bool softfailuretest(failure_type type);

// Globals to control printing
extern bool printing_is_switchable;
extern bool printing_is_off;

// Printing control functions
inline void print_on() {
  if (printing_is_switchable)
    printing_is_off = false;
}
inline void print_off() {
  if (printing_is_switchable)
    printing_is_off = true;
}

#endif
